/*
 * MIT License
 *
 * Copyright (c) 2018 Felix Pröhl
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.gitee.wsl.collections.map.api

import com.gitee.wsl.collections.api.Boundable
import com.gitee.wsl.collections.api.MutableBoundable

/**
 * A [Map] that has a fixed capacity of [Map.entries].
 */
interface BoundedMap<K, out V>: Map<K, V>, Boundable{

    override val isFull: Boolean
        get() = size == maxCapacity

}

/**
 * A [MutableList] that has a fixed capacity of [Map.entries].
 */
interface MutableBoundedMap<K, V>: MutableMap<K, V>, BoundedMap<K, V>, MutableBoundable {

    /**
     * Puts the entry in the [MutableBoundedMap].
     * @throws IndexOutOfBoundsException, if the [MutableMap]'s [maxCapacity] is reached.
     */
    override fun put(key: K, value: V): V?

    /**
     * Puts the entries in the [MutableBoundedMap].
     * @throws IndexOutOfBoundsException, if the [MutableMap]'s [maxCapacity] is reached.
     */
    override fun putAll(from: Map<out K, V>)

    /**
     * Adds items to the [MutableBoundedMap].
     * If the [MutableBoundedMap]'s [maxCapacity] is reached, the item gets added to the tail
     * and the head (the oldest item) gets removed.
     * @return true, if head item was removed
     */
    fun forcePut(key: K, value: V): Boolean

    /**
     * Adds items to the [MutableBoundedMap].
     * If the [MutableBoundedMap]'s [maxCapacity] is reached, the item gets added to the tail
     * and the head (the oldest item) gets removed.
     * @return true, if head item was removed
     */
    fun forcePutAll(from: Map<out K, V>): Boolean
}
